<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Dwoo_Template_String</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Dwoo_Template_String</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
                <p class="implements">
            Implements interfaces:
            <ul>
                <li><a href="../Dwoo/Dwoo_ITemplate.html">Dwoo_ITemplate</a></li>            </ul>
        </p>
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">represents a Dwoo template contained in a string</p>
<p class="description"><p>This software is provided 'as-is', without any express or implied warranty.  In no event will the authors be held liable for any damages arising from the use of this software.</p><p>This file is released under the LGPL  &quot;GNU Lesser General Public License&quot;  More information can be found here:  <a href="http://www.gnu.org/copyleft/lesser.html">http://www.gnu.org/copyleft/lesser.html</a></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jordi Boggiano &lt;<a href="mailto:j.boggiano@seld.be">j.boggiano@seld.be</a>&gt;</li>
				<li><span class="field">version:</span> 0.9.1</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008, Jordi Boggiano</li>
				<li><span class="field">link:</span> <a href="http://dwoo.org/">http://dwoo.org/</a></li>
				<li><span class="field">date:</span> 2008-05-30</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Dwoo---Template---String.php.html">/Dwoo/Template/String.php</a> (line <span class="field"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a22">22</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Dwoo/Dwoo_Template_File.html">Dwoo_Template_File</a></td>
					<td>
											represents a Dwoo template contained in a file
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
												<div class="var-title">
					static <span class="var-type">array</span>
					<a href="#$cache" title="details" class="var-name">$cache</a>
				</div>
																																																																												<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$cacheId" title="details" class="var-name">$cacheId</a>
				</div>
																<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$cacheTime" title="details" class="var-name">$cacheTime</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$compilationEnforced" title="details" class="var-name">$compilationEnforced</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$compileId" title="details" class="var-name">$compileId</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>
					<a href="#$compiler" title="details" class="var-name">$compiler</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$name" title="details" class="var-name">$name</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																		
				<div class="method-definition">
					static 						<span class="method-result">false</span>
										<a href="#templateFactory" title="details" class="method-name">templateFactory</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$resourceId</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$cacheTime</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$cacheId</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compileId</span> = <span class="var-default">null</span>])
									</div>
																		
				<div class="method-definition">
											<span class="method-result">Dwoo_Template_String</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$templateString</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$cacheTime</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$cacheId</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compileId</span> = <span class="var-default">null</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#cache" title="details" class="method-name">cache</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$output</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#clearCache" title="details" class="method-name">clearCache</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$olderThan</span> = <span class="var-default">-1</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#forceCompilation" title="details" class="method-name">forceCompilation</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string|bool</span>
										<a href="#getCachedTemplate" title="details" class="method-name">getCachedTemplate</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getCacheFilename" title="details" class="method-name">getCacheFilename</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">int|null</span>
										<a href="#getCacheTime" title="details" class="method-name">getCacheTime</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getCompiledFilename" title="details" class="method-name">getCompiledFilename</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getCompiledTemplate" title="details" class="method-name">getCompiledTemplate</a>
											(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, [<span class="var-type"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>&nbsp;<span class="var-name">$compiler</span> = <span class="var-default">null</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>
										<a href="#getCompiler" title="details" class="method-name">getCompiler</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">false</span>
										<a href="#getResourceIdentifier" title="details" class="method-name">getResourceIdentifier</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getResourceName" title="details" class="method-name">getResourceName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getSource" title="details" class="method-name">getSource</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getUid" title="details" class="method-name">getUid</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#makeDirectory" title="details" class="method-name">makeDirectory</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setCacheTime" title="details" class="method-name">setCacheTime</a>
											([<span class="var-type">int</span>&nbsp;<span class="var-name">$seconds</span> = <span class="var-default">null</span>])
									</div>
																			</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$cache" id="$cache"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>
			<span class="var-name">$cache</span>
			 = <span class="var-default">array('cached'=&gt;array(),'compiled'=&gt;array())</span>			(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a74">74</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">caches the results of the file checks to save some time when the same  templates is rendered several times</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>

<a name="var$cacheId" id="$cacheId"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$cacheId</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a48">48</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">template cache id, if not provided in the constructor, it is set to  the md5 hash of the request_uri. it is however highly recommended to  provide one that will fit your needs.</p>
<p class="description"><p>in all cases, the compilation id is prepended to the cache id to separate  templates with similar cache ids from one another</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$cacheTime" id="$cacheTime"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$cacheTime</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a57">57</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">validity duration of the generated cache file (in seconds)</p>
<p class="description"><p>set to -1 for infinite cache, 0 to disable and null to inherit the Dwoo instance's cache time</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$compilationEnforced" id="$compilationEnforced"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$compilationEnforced</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a66">66</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">boolean flag that defines whether the compilation should be enforced (once) or  not use this if you have issues with the compiled templates not being updated  but if you do need this it's most likely that you should file a bug report</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$compileId" id="$compileId"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$compileId</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a36">36</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">template compilation id</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$compiler" id="$compiler"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>
			<span class="var-name">$compiler</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a81">81</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">holds the compiler that built this template</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$name" id="$name"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$name</span>
						(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a29">29</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">template name</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodtemplateFactory" id="templateFactory"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static templateFactory</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a371">371</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns false as this template type does not support inclusions</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">false</span>
		<span class="method-name">
			templateFactory
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$resourceId</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$cacheTime</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$cacheId</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compileId</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$resourceId</span><span class="var-description">: the filename (relative to this template's dir) of the template to include</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$cacheTime</span><span class="var-description">: duration of the cache validity for this template,                           if null it defaults to the Dwoo instance that will                           render this template</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$cacheId</span><span class="var-description">: the unique cache identifier of this page or anything else that                            makes this template's content unique, if null it defaults                            to the current url</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$compileId</span><span class="var-description">: the unique compiled identifier, which is used to distinguish this                              template from others, if null it defaults to the filename+bits of the path</span>			</li>
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodtemplateFactory">Dwoo_ITemplate::templateFactory()</a></dt>
						<dd>returns a new template object from the given include name, null if no include is  possible (resource not found), or false if include is not permitted by this resource type</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodtemplateFactory">Dwoo_Template_File::templateFactory()</a>
								: returns a new template object from the given include name, null if no include is  possible (resource not found), or false if include is not permitted by this resource type
							</li>
				</ul>
	</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a96">96</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">creates a template from a string</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Dwoo_Template_String</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$templateString</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$cacheTime</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$cacheId</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compileId</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$templateString</span><span class="var-description">: the template to use</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$cacheTime</span><span class="var-description">: duration of the cache validity for this template,                           if null it defaults to the Dwoo instance that will                           render this template, set to -1 for infinite cache or 0 to disable</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$cacheId</span><span class="var-description">: the unique cache identifier of this page or anything else that                            makes this template's content unique, if null it defaults                            to the current url</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$compileId</span><span class="var-description">: the unique compiled identifier, which is used to distinguish this                              template from others, if null it defaults to the md5 hash of the template</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#method__construct">Dwoo_Template_File::__construct()</a>
								: creates a template from a file
							</li>
				</ul>
	</div>
<a name="methodcache" id="cache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">cache</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a255">255</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">caches the provided output into the cache file</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			cache
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$output</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that requests it</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$output</span><span class="var-description">: the template output</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodcache">Dwoo_ITemplate::cache()</a></dt>
						<dd>caches the provided output into the cache file</dd>
					</dl>
			
	</div>
<a name="methodclearCache" id="clearCache"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">clearCache</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a297">297</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">clears the cached template if it's older than the given time</p>
	<ul class="tags">
				<li><span class="field">return:</span> true if the cache was not present or if it was deleted, false if it remains there</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			clearCache
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$olderThan</span> = <span class="var-default">-1</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that was used to cache that template</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$olderThan</span><span class="var-description">: minimum time (in seconds) required for the cache to be cleared</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodclearCache">Dwoo_ITemplate::clearCache()</a></dt>
						<dd>clears the cached template if it's older than the given time</dd>
					</dl>
			
	</div>
<a name="methodforceCompilation" id="forceCompilation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">forceCompilation</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a206">206</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">marks this template as compile-forced, which means it will be recompiled even if it</p>
<p class="description"><p>was already saved and wasn't modified since the last compilation. do not use this in production,  it's only meant to be used in development (and the development of dwoo particularly)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			forceCompilation
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetCachedTemplate" id="getCachedTemplate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getCachedTemplate</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a218">218</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the cached template output file name, true if it's cache-able but not cached  or false if it's not cached</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|bool</span>
		<span class="method-name">
			getCachedTemplate
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that requests it</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetCachedTemplate">Dwoo_ITemplate::getCachedTemplate()</a></dt>
						<dd>returns the cached template output file name, true if it's cache-able but not cached  or false if it's not cached</dd>
					</dl>
			
	</div>
<a name="methodgetCacheFilename" id="getCacheFilename"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCacheFilename</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a400">400</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the full cached file name and assigns a default value to it if  required</p>
	<ul class="tags">
				<li><span class="field">return:</span> the full path to the cached file</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getCacheFilename
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that requests the file name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetCacheTime" id="getCacheTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getCacheTime</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a120">120</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the cache duration for this template</p>
<p class="description"><p>defaults to null if it was not provided</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int|null</span>
		<span class="method-name">
			getCacheTime
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetCacheTime">Dwoo_ITemplate::getCacheTime()</a></dt>
						<dd>returns the cache duration for this template</dd>
					</dl>
			
	</div>
<a name="methodgetCompiledFilename" id="getCompiledFilename"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCompiledFilename</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a383">383</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the full compiled file name and assigns a default value to it if  required</p>
	<ul class="tags">
				<li><span class="field">return:</span> the full path to the compiled file</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getCompiledFilename
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that requests the file name</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetCompiledFilename">Dwoo_Template_File::getCompiledFilename()</a>
								: returns the full compiled file name and assigns a default value to it if  required
							</li>
				</ul>
	</div>
<a name="methodgetCompiledTemplate" id="getCompiledTemplate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getCompiledTemplate</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a311">311</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the compiled template file name</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getCompiledTemplate
		</span>
					(<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>, [<span class="var-type"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>&nbsp;<span class="var-name">$compiler</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance that requests it</span>			</li>
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>
				<span class="var-name">$compiler</span><span class="var-description">: the compiler that must be used</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetCompiledTemplate">Dwoo_ITemplate::getCompiledTemplate()</a></dt>
						<dd>returns the compiled template file name</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetCompiledTemplate">Dwoo_Template_File::getCompiledTemplate()</a>
								: returns the compiled template file name
							</li>
				</ul>
	</div>
<a name="methodgetCompiler" id="getCompiler"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCompiler</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a196">196</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the compiler used by this template, if it was just compiled, or null</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Dwoo/Dwoo_ICompiler.html">Dwoo_ICompiler</a></span>
		<span class="method-name">
			getCompiler
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetCompiler">Dwoo_ITemplate::getCompiler()</a></dt>
						<dd>returns the compiler used by this template, if it was just compiled, or null</dd>
					</dl>
			
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a145">145</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the template name</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetName">Dwoo_ITemplate::getName()</a></dt>
						<dd>returns the template name</dd>
					</dl>
			
	</div>
<a name="methodgetResourceIdentifier" id="getResourceIdentifier"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getResourceIdentifier</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a165">165</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the resource identifier for this template, false here as strings don't have identifiers</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">false</span>
		<span class="method-name">
			getResourceIdentifier
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetResourceIdentifier">Dwoo_ITemplate::getResourceIdentifier()</a></dt>
						<dd>returns the resource identifier for this template or false if it has no identifier</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetResourceIdentifier">Dwoo_Template_File::getResourceIdentifier()</a>
								: returns this template's source filename
							</li>
				</ul>
	</div>
<a name="methodgetResourceName" id="getResourceName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getResourceName</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a155">155</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the resource name for this template class</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getResourceName
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetResourceName">Dwoo_ITemplate::getResourceName()</a></dt>
						<dd>returns the resource name for this template class</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetResourceName">Dwoo_Template_File::getResourceName()</a>
								: returns the resource name for this template class
							</li>
				</ul>
	</div>
<a name="methodgetSource" id="getSource"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSource</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a175">175</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns the template source of this template</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getSource
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetSource">Dwoo_ITemplate::getSource()</a></dt>
						<dd>returns the template source of this template</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetSource">Dwoo_Template_File::getSource()</a>
								: returns the template source of this template
							</li>
				</ul>
	</div>
<a name="methodgetUid" id="getUid"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUid</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a186">186</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns an unique value identifying the current version of this template,  in this case it's the md4 hash of the content</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getUid
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodgetUid">Dwoo_ITemplate::getUid()</a></dt>
						<dd>returns an unique string identifying the current version of this template,  for example a timestamp of the last modified date or a hash of the template source</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Dwoo/Dwoo_Template_File.html#methodgetUid">Dwoo_Template_File::getUid()</a>
								: returns an unique value identifying the current version of this template,  in this case it's the unix timestamp of the last modification
							</li>
				</ul>
	</div>
<a name="methodmakeDirectory" id="makeDirectory"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">makeDirectory</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a419">419</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ensures the given path exists</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			makeDirectory
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path</span><span class="var-description">: any path</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetCacheTime" id="setCacheTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setCacheTime</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__DwooTemplateString.php.html#a135">135</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">sets the cache duration for this template</p>
<p class="description"><p>can be used to set it after the object is created if you did not provide  it in the constructor</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setCacheTime
		</span>
					([<span class="var-type">int</span>&nbsp;<span class="var-name">$seconds</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$seconds</span><span class="var-description">: duration of the cache validity for this template, if  null it defaults to the Dwoo instance's cache time. 0 = disable and  -1 = infinite cache</span>			</li>
				</ul>
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Dwoo/Dwoo_ITemplate.html#methodsetCacheTime">Dwoo_ITemplate::setCacheTime()</a></dt>
						<dd>sets the cache duration for this template</dd>
					</dl>
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 30 May 2008 04:51:49 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>